Skip to main content

Request Password Reset

User Password Reset Request​

The endpoint below enables you to request password reset.

POST /api/v1/auth/password/request-reset

NOTE : Bearer token is not required for password reset request.

authorization : *bearer token
REQUEST BODY SCHEMA : application/json
username
required
string

Email or phone number of the user

{
  • "username": "+233123456789"
}

When a user (individual client or corporate client) requests for a password reset, the following actions must happen.

  • A password reset code will be sent to the user’s email or an sms will be sent to the user’s phone number. The code is sent to the username provided during the sign up process ( i.e phone number or email).

  • If the code is sent successfully, use /auth/password/reset to reset the user’s password.

  • The code is valid for 15 minutes.

The request must include either the Email or Phone Number of the user.

username
required
string

Email or phone number of the user

{
  • "username": "+233123456789"
}